Skip to main content

Sigmafine Balance - Required Attributes

The Sigmafine Balance Analysis Rule requires that elements have Attributes configured to have specific Attribute properties including, value type and unit of measure. Input and Output Attributes are listed in these sections:

With the Sigmafine Balance Analysis Rule, the basis of the analysis is configurable to any available UOM class. For setting the defaults for Attribute names and other requirements, see \ the Sigmafine Balance Table topic under Server & Client. The Element Attribute is part of the analysis if the following selection criteria are met:

  • The Attribute has the appropriate UOM class.
  • The Element is created from a template with the appropriate Element category.
  • The Attribute has the appropriate Attribute category of SF_AnalysisInput or SF_AnalysisOutput.
  • The Attribute is of the appropriate Value type.

Element Attributes that are listed with multiple templates must have common naming across the named templates.

Sigmafine Balance Analysis – Input Quantity Attributes

Analysis Configuration - Input Attribute Requirements

ConfigurationAttribute Unit ClassParameter Value TypeElement CategoryAttribute CategoryDefault Template Name(s)Default Attribute Name
Measurement\<configurable>1DoubleSF_TankSF_MassVolumeMeterSF_TransferSF_AnalysisInputANDSF_CaseInputData 2SF_GaugedTankTemplateSF_VolumeTankTemplateSF_LiquidMeterTemplateSF_GasMeterTemplateSF_SolidMeterTemplateSF_TransferTemplateMeasuredMass
Measurement ToleranceMust match Measurement UOMDouble\<Same as above>\<Same as above>\<Same as above>MassTolerance
Self-Calculating FlagNoneBooleanSF_TankSF_AnalysisInputSF_GaugedTankTemplateSF_VolumeTankTemplateSelfCalculatingFlag
1 See Using the SF_SigmafineBalance Table for more information about setting the Attribute UOM Class.2 For an Attribute to be saved in the Case input data set, the Attribute must belong to the SF_CaseInputData category. You can decrease the size of the stored data set by removing this Attribute category.

Sigmafine Balance Analysis – Output Quantity Attributes

Analysis Configuration - Output Attribute Requirements

ConfigurationAttribute Unit ClassParameter Value TypeElement CategoryAttribute CategoryDefault Template Name(s)Default Attribute Name
Reconciled Status\<dimensionless>StringSF_TankSF_MassVolumeMeterSF_TransferSF_FlowSF_AnalysisOutputANDSF_CaseResults1SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplateSF_LiquidMeterTemplateSF_GasMeterTemplateInferredStatus
Reconciled MeasurementMust match Measurement UOMDoubleSF_TankSF_TransferSF_Flow\<Same as above>SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplateReconciledMass
Reconciled Tolerance\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>
Solvability\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassSolvability
Influence\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>
Reconciled AdjustmentMust match Measurement UOMDouble\<Same as above>\<Same as above>\<Same as above>ReconciledMassCorrection
Test 1\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassTest1
Test 2\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassTest2
Initial ImbalanceMust match Measurement UOMDoubleSF_TankSF_NodeSF_ProcessSF_Manifold\<Same as above>SF_GaugedTankTemplateSF_VolumeTankTemplateSF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplateReconciledMassImbalance
Variance\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassVariance
Test 3\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassTest3
Test 4\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassTest4
Reconciled Residual\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledResidual
1 For an Attribute to be saved in the Case output data set, the Attribute must belong to the SF_CaseResults category. You can decrease the size of the stored data set by removing this Attribute category.

Sigmafine Balance Analysis – Heat Exchanger Output Attributes

When heat exchangers are included in a model, they have additional requirements as noted in the table below.

Analysis Configuration - Heat Exchanger Output Attribute Requirements

SideConfiguration ParameterAttribute Unit ClassParameter Value TypeElement CategoryAttribute CategoryDefault Template Name(s)Default Attribute Name
Shell SideInitial ImbalanceMust match Measurement UOMDoubleSF_HeatExchangerSF_AnalysisOutputANDSF_CaseResults1SF_HeatExchangerTemplateReconciledMassShellImbalance
Variance\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellVariance
Test 3\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellTest3
Test 4\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellTest4
Reconciled Residual\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellResidual
Tube SideInitial ImbalanceMust match Measurement UOMDoubleSF_HeatExchanger\<Same as above>SF_HeatExchangerTemplateReconciledMassShellImbalance
Variance\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellVariance
Test 3\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellTest3
Test 4\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellTest4
Reconciled Residual\<dimensionless>Double\<Same as above>\<Same as above>\<Same as above>ReconciledMassShellResidual
1 For an Attribute to be saved in the Case output data set, the Attribute must belong to the SF_CaseResults category. You can decrease the size of the stored data set by removing this Attribute category.

Note: The Element template for the heat exchangers (default name is SF_HeatExchangerTemplate) requires the following four ports to be defined. The port names must remain as shown in the table.

Analysis Configuration - Output Attribute Requirements

NameDescriptionPort TypeMaximum ConnectionsConnection TypeDefault PortAllowed Element Template
Shell InInput PortInput0Flow, TransferFalse\<All>
Shell OutOutput PortOutput0Flow, TransferFalse\<All>
Tube InInput PortInput0Flow, TransferFalse\<All>
Tube OutOutput PortOutput0Flow, TransferFalse\<All>